<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>simvoc.core.results.Result</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="simvoc-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >SimVOC</th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="simvoc-module.html">Package&nbsp;simvoc</a> ::
        <a href="simvoc.core-module.html">Package&nbsp;core</a> ::
        <a href="simvoc.core.results-module.html">Module&nbsp;results</a> ::
        Class&nbsp;Result
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class Result</h1><p class="nomargin-top"><span class="codelink"><a href="simvoc.core.results-pysrc.html#Result">source&nbsp;code</a></span></p>
<center>
<center>  <map id="uml_class_diagram_for_simvoc_c_35" name="uml_class_diagram_for_simvoc_c_35">
<area shape="rect" id="node72" href="simvoc.core.results.Result-class.html#__init__" title="x.__init__(...) initializes x; see x.__class__.__doc__ for signature" alt="" coords="1200,39,1533,57"/>
<area shape="rect" id="node72" href="simvoc.core.results.Result-class.html#add_field" title="Adds a field to the result class." alt="" coords="1200,57,1533,76"/>
<area shape="rect" id="node72" href="simvoc.core.results.Result-class.html#same_as" title="Compares two results to determine if they are duplicates." alt="" coords="1200,76,1533,95"/>
<area shape="rect" id="node72" href="simvoc.core.results.Result-class.html#__str__" title="str(x)" alt="" coords="1200,95,1533,113"/>
<area shape="rect" id="node1" href="simvoc.core.results.Result-class.html" title="Base class for simulation results." alt="" coords="1188,6,1545,119"/>
<area shape="rect" id="node2" href="simvoc.core.results.FileRequestResult-class.html" title="Result that occurs whenever a file is requested from a FileCache" alt="" coords="5,139,147,178"/>
<area shape="rect" id="node3" href="simvoc.core.results.MetadataResult-class.html" title="Result class for injecting metadata into the simulator output." alt="" coords="176,139,301,178"/>
<area shape="rect" id="node4" href="simvoc.core.results.TraceResult-class.html" title="Result produced by the kernel_trace function in this module, to record the simulation trace as part of the output data" alt="" coords="331,139,435,178"/>
<area shape="rect" id="node5" href="simvoc.core.results.VMResult-class.html" title="Result produced whenever a Virtual Machine changes state" alt="" coords="464,139,557,178"/>
<area shape="rect" id="node6" href="simvoc.core.results.SiteRejectionResult-class.html" title="Result that records the rejection of a site at creation time, specifying the site name and reason for rejection." alt="" coords="587,139,736,178"/>
<area shape="rect" id="node7" href="simvoc.core.results.WatchdogResult-class.html" title="Result periodically produced to monitor the state of the watchdog component" alt="" coords="765,139,896,178"/>
<area shape="rect" id="node8" href="simvoc.core.results.VOResult-class.html" title="Result that records the observation of a single Virtual Organization in the trace data." alt="" coords="925,139,1016,178"/>
<area shape="rect" id="node9" href="simvoc.core.results.AggregationResult-class.html" title="Result type produced by the Aggregator component." alt="" coords="1045,139,1187,178"/>
<area shape="rect" id="node10" href="simvoc.core.results.JobSubmitResult-class.html" title="Result that is sent when a job is successfully submitted" alt="" coords="1216,139,1349,178"/>
<area shape="rect" id="node11" href="simvoc.core.results.DiscrepancyResult-class.html" title="Result type produced whenever a job, or the simulated grid, must be changed due to invalid information contained in the job trace." alt="" coords="1379,139,1523,178"/>
<area shape="rect" id="node12" href="simvoc.core.results.SchedResult-class.html" title="Scheduling result record, which encodes the scheduler status information both for the entire scheduler and for each Virtual Organization seen by the scheduler." alt="" coords="1552,139,1661,178"/>
<area shape="rect" id="node13" href="simvoc.core.results.SiteResult-class.html" title="Result that records the presence or absence of a site on the grid." alt="" coords="1691,139,1787,178"/>
<area shape="rect" id="node14" href="simvoc.core.results.VMPilotResult-class.html" title="Result produced by Virtual Machine pilot jobs whenever the pilot state changes" alt="" coords="1816,139,1933,178"/>
<area shape="rect" id="node15" href="simvoc.core.results.DiscardResult-class.html" title="Result created whenever a job is discarded without simulating its execution." alt="" coords="1963,139,2080,178"/>
<area shape="rect" id="node16" href="simvoc.core.results.JobStartResult-class.html" title="Record dispatched when a job is started" alt="" coords="2109,139,2229,178"/>
<area shape="rect" id="node17" href="simvoc.core.results.JobResult-class.html" title="Record of a Job, entered into the output pipeline whenever the job completes or is discarded" alt="" coords="2259,139,2352,178"/>
<area shape="rect" id="node18" href="simvoc.core.results.VOCResult-class.html" title="Result used for periodic updates on the state of a Virtual Organization Cluster." alt="" coords="2381,139,2483,178"/>
<area shape="rect" id="node19" href="simvoc.core.results.FileTransferResult-class.html" title="Result to record a transfer from a FileStore to a FileCache (in the event of a cache miss) or another other file transfer" alt="" coords="2512,139,2651,178"/>
</map>
  <img src="uml_class_diagram_for_simvoc_c_35.gif" alt='' usemap="#uml_class_diagram_for_simvoc_c_35" ismap="ismap" class="graph-without-title" />
</center>
</center>
<hr />
<p>Base class for simulation results. Each result is labeled with a 
  result type, so that postprocessing routines can be developed without 
  having to import simulator core modules. All results are also labeled 
  with the entity producing the result, a timestamp (where applicable), and
  an optional message.</p>
  <p>Results also contain fields, which are implemented as a dictionary of 
  name: value pairs. Field names are strings, while values must be one of 
  several primitive types: None, int, str, float, or bool. Fields may also 
  be specified as using delta, or difference, calculations, for use with 
  the aggregator post-processing module.</p>

<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Instance Methods</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-InstanceMethods"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="simvoc.core.results.Result-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">result_type</span>,
        <span class="summary-sig-arg">entity</span>,
        <span class="summary-sig-arg">timestamp</span>,
        <span class="summary-sig-arg">message</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>)</span><br />
      x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="simvoc.core.results-pysrc.html#Result.__init__">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="simvoc.core.results.Result-class.html#add_field" class="summary-sig-name">add_field</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">field</span>,
        <span class="summary-sig-arg">value</span>,
        <span class="summary-sig-arg">use_delta</span>=<span class="summary-sig-default">False</span>)</span><br />
      Adds a field to the result class.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="simvoc.core.results-pysrc.html#Result.add_field">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">bool</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="simvoc.core.results.Result-class.html#same_as" class="summary-sig-name">same_as</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">other</span>)</span><br />
      Compares two results to determine if they are duplicates.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="simvoc.core.results-pysrc.html#Result.same_as">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="simvoc.core.results.Result-class.html#__str__" class="summary-sig-name">__str__</a>(<span class="summary-sig-arg">self</span>)</span><br />
      str(x)</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="simvoc.core.results-pysrc.html#Result.__str__">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__delattr__</code>,
      <code>__format__</code>,
      <code>__getattribute__</code>,
      <code>__hash__</code>,
      <code>__new__</code>,
      <code>__reduce__</code>,
      <code>__reduce_ex__</code>,
      <code>__repr__</code>,
      <code>__setattr__</code>,
      <code>__sizeof__</code>,
      <code>__subclasshook__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Properties</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Properties"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__class__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Method Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-MethodDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">result_type</span>,
        <span class="sig-arg">entity</span>,
        <span class="sig-arg">timestamp</span>,
        <span class="sig-arg">message</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>)</span>
    <br /><em class="fname">(Constructor)</em>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="simvoc.core.results-pysrc.html#Result.__init__">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>x.__init__(...) initializes x; see x.__class__.__doc__ for 
  signature</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>result_type</code></strong> (str) - Name of the result type</li>
        <li><strong class="pname"><code>entity</code></strong> (str) - Name of the entity producing the result</li>
        <li><strong class="pname"><code>timestamp</code></strong> - Timestamp of the result, which may be a number, a tuple in the 
          form (clock, relative_time), or None (to indicate that this type 
          of result is not timestamped)</li>
        <li><strong class="pname"><code>message</code></strong> (str) - Message to accompany the result</li>
    </ul></dd>
    <dt>Overrides:
        object.__init__
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="add_field"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">add_field</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">field</span>,
        <span class="sig-arg">value</span>,
        <span class="sig-arg">use_delta</span>=<span class="sig-default">False</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="simvoc.core.results-pysrc.html#Result.add_field">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Adds a field to the result class. Field values must be primitive types
  (None, int, str, float, bool). If use_delta is set to True, then the 
  fields will be flagged for use with the aggregation post-processor.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>field</code></strong> (str) - Field name to add</li>
        <li><strong class="pname"><code>value</code></strong> - Value of the field (must be a primitive type)</li>
        <li><strong class="pname"><code>use_delta</code></strong> (bool) - enable or disable field aggregation</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="same_as"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">same_as</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">other</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="simvoc.core.results-pysrc.html#Result.same_as">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Compares two results to determine if they are duplicates. In this 
  comparison, time values are ignored, but messages and other strings use 
  case-sensitive comparisons.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>other</code></strong> (Result) - Other result against which to compare</li>
    </ul></dd>
    <dt>Returns: bool</dt>
        <dd>True iff this result and the other result vary only by time (or 
          not at all)</dd>
  </dl>
</td></tr></table>
</div>
<a name="__str__"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__str__</span>(<span class="sig-arg">self</span>)</span>
    <br /><em class="fname">(Informal representation operator)</em>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="simvoc.core.results-pysrc.html#Result.__str__">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>str(x)</p>
  <dl class="fields">
    <dt>Overrides:
        object.__str__
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="simvoc-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >SimVOC</th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0 on Fri Oct 23 11:04:32 2009
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
